package com.yvon.boot.mybatis.search;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 排序
 * 接收前端排序规则，进行排序
 *
 * @author yvon
 * @since 2022-12-12
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.PARAMETER})
public @interface MpOrder {

    /**
     * 别名
     * 对于查询语句中字段所在表的别名
     *
     * @return {@code String }
     */
    String alias() default "";

    /**
     * 字段名
     * 对于查询语句中字段名称
     *
     * @return {@code String[] }
     */
    String[] fieldName() default {};


    MpOrder.Order order() default MpOrder.Order.none;

    public enum Order {
        asc,
        desc,
        none;

        Order() {
        }
    }
}
